-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Azure.Search.Documents 2025-11-01-preview API Release #53367
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…o efrainretana/2025-11-01-preview
…o efrainretana/2025-11-01-preview
API Change CheckAPIView identified API level changes in this PR and created the following API reviews |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR performs a comprehensive renaming from "KnowledgeAgent" to "KnowledgeBase" across the Azure Search Documents SDK, updates the API version from 2025-08-01-preview to 2025-11-01-preview, and introduces new features including metric facets support, web knowledge sources, and enhanced retrieval capabilities.
Key Changes:
- Rename all "KnowledgeAgent" references to "KnowledgeBase" throughout test utilities, clients, models, and generated code
- Update service API version from
V2025_08_01_PreviewtoV2025_11_01_Preview - Add support for new facet metrics (avg, min, max, cardinality) in search results
- Introduce new web-based knowledge sources and related models
- Add elevated read permissions and agentic reasoning capabilities
Reviewed Changes
Copilot reviewed 2 out of 252 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| SearchResources.cs | Renamed KnowledgeAgent properties/methods to KnowledgeBase equivalents |
| KnowledgeBaseModelComparer.cs | Renamed class from KnowledgeAgentModelComparer |
| SearchIndexerClientTests.cs | Updated API version references |
| SearchIndexClientTests.cs | Renamed test methods and updated to use KnowledgeBase APIs |
| SearchClient.cs | Added enableElevatedRead parameter, updated documentation from "Cognitive Search" to "AI Search" |
| SearchClientOptions.cs | Updated service version enum and constants |
| Constants.cs | Added new facet metric constants (Avg, Min, Max, Cardinality) |
| SearchResults.cs | Added deserialization support for new facet metrics |
| FacetType.cs | Added new facet type enums |
| FacetResult.cs | Enhanced FacetType logic to support new metrics |
| KnowledgeBaseRetrievalClient.cs | Renamed from KnowledgeAgentRetrievalClient |
| SearchIndexClient.KnowledgeBases.cs | Renamed methods and updated to use KnowledgeBase terminology |
| Various Generated Models | Added new web knowledge source models and serialization |
Contributing to the Azure SDK
Please see our CONTRIBUTING.md if you are not familiar with contributing to this repository or have questions.
For specific information about pull request etiquette and best practices, see this section.